home *** CD-ROM | disk | FTP | other *** search
/ Computer Shopper 235 / Issue 235 - September 2007 - DPCS0907DVD.ISO / Extras / NetObjects Fusion / NOF10.exe / data1.cab / FSI / lib / nof / text / MessageFormat.js < prev    next >
Encoding:
Text File  |  2007-04-11  |  3.0 KB  |  98 lines
  1. /****i* SOURCE_FILE/INFO
  2.   *
  3.   * NAME
  4.   *  MessageFormat.js
  5.   *
  6.   * USAGE
  7.   *  Part of Netobjects JavaScript Library.
  8.   *
  9.   * COPYRIGHT
  10.   *  Copyright ⌐ 2000-2005 Website Pros, Inc.
  11.   *  All Rights Reserved.
  12.   *
  13.   *  This is an unpublished work protected by Website Pros, Inc.
  14.   *  as a trade secret, and is not to be used or disclosed except as
  15.   *  expressly provided in a written license agreement executed by
  16.   *  you and Website Pros, Inc.
  17.   *
  18.   *      <copyright@websitepros.com>
  19.   *
  20.   * NOTES
  21.   *  JavaScript code.
  22.   *
  23.   *****/
  24. if (!IS.isModuleInitialized("IS.NOF.TEXT.MessageFormat"))
  25. { 
  26.   
  27.   /****h* NOF_JavaScript_Library/NOF.TEXT.MessageFormat
  28.     *
  29.     * NAME
  30.     *  NOF.TEXT.MessageFormat
  31.     *
  32.     * DESCRIPTION
  33.     *
  34.     * <code>MessageFormat</code> is a class which provides a simple way to 
  35.     * format a text using parameters.
  36.     * Usage sample:
  37.     * var myPattern = "{0} is smaller than {1}, thus {1} is greater than {0}";
  38.     *   var myParams = ["the number 3", "the number 4"];
  39.     *   var str = NOF.TEXT.MessageFormat.format(myPattern, myParams);
  40.     *   alert( str );
  41.     *
  42.     * External dependencies: none.
  43.     ****/
  44.   
  45.   /**
  46.     * Constructor
  47.     **/
  48.   function TEXT_MessageFormat() {
  49.     this.__proto__ = TEXT_MessageFormat.prototype;
  50.   }
  51.   {
  52.     var method = TEXT_MessageFormat.prototype;                
  53.     
  54.     /**
  55.     * static method used to format a message
  56.     * @param pattern the pattern for this message format
  57.     * @param params an array of objects (strings) to be formatted and substituted.
  58.     * @return the string obtained by replacing {x} sequences from the pattern with
  59.     * params[x] values, where x are indices from 0 to params length
  60.     **/
  61.     method.format = function (/*string*/ pattern, /*Array*/ params) {
  62.       if (pattern == null) return null;
  63.       if (params == null) return pattern;
  64.       
  65.       var parameters;
  66.       
  67.       //if (params.constructor == Array) {                
  68.       //the previous line should have been working, but it doesn't! 
  69.       //the next lines makes the difference between strings and arrays
  70.       //if ( (""+params.constructor).indexOf("function Array()") > -1) {                
  71.       if (params.join) {                            
  72.         parameters = params;                
  73.       } else {
  74.         //probably the method was called in the old fashion way, like this: 
  75.         //NOF.TEXT.MessageFormat.format("{0} bla bla {1}", "BLA", "ALB");                                
  76.         parameters = new Array();
  77.         for (var i = 1; i < arguments.length; i++) {
  78.           parameters[i - 1] = arguments[i];
  79.         }
  80.       }            
  81.       
  82.       var str = pattern;            
  83.       var substr = null;
  84.       var j;
  85.       for (var i=0; i < parameters.length; i++) {
  86.         substr = "{" + i + "}";
  87.         while (true) {
  88.           j = str.indexOf(substr);
  89.           if (j < 0) break;
  90.           str = str.substring(0,j) + parameters[i] + str.substring(j+substr.length, str.length);
  91.         }    
  92.       }
  93.       return str;                            
  94.     }
  95.   }
  96.   // add it to NOF.TEXT namespace
  97.   TEXT.__proto__.MessageFormat = new TEXT_MessageFormat();
  98. }